---
title: "get form data · RUAL Documentation"
description: "Retrieves the form data from the state."
canonical: https://docs.rual.nl/block-types/state ui/state_form_get
language: en
---

# get form data

This block is part of the [`state ui`](https://docs.rual.nl/block-types/state%20ui) group and was last modified in core [`v10.4.28`](https://docs.rual.nl/core-versions/100428).

### Fields Selection Required

This block relies on fields that you selected to perform its data actions. You must manually select the fields you want to use in your flow using the fields selector modal. To access the modal, click the white button on the block.

### Field Selection Required

This block requires field selection (out). You must manually select the fields you want to work with using the field selector modal. To access the modal, click the white button on the block.

Retrieves the form data from the state.

- flow `flow`

- form id required `value` A unique ID for the form. Used to retrieve the data

- flow `flow`

- error `value`

- data `object`

A typical wiring for [get form data](https://docs.rual.nl/block-types/state%20ui/state_form_get): [value](https://docs.rual.nl/block-types/value/value_default) feeds the `form_id` pin; the `flow` out pin feeds [execute](https://docs.rual.nl/block-types/function%20execution/function_custom_execute).

![Studio canvas example for the get form data block: typical wiring for get form data.](https://docs.rual.nl/canvas-examples/state_form_get.png)

### Commonly used with

In production blueprints, this block is most often wired together with:

- [execute](https://docs.rual.nl/block-types/function%20execution/function_custom_execute): this block feeds into it. Executes the given funcion and waits for it to be executed.

- [create](https://docs.rual.nl/block-types/globals/trigger_custom_function): feeds into this block. Creates a new function that can be executed using the given name.

- [value](https://docs.rual.nl/block-types/value/value_default): feeds into this block. Simply returns the provided value.

### Used in these guides

These documentation pages use or explain this block:

- [File Upload & Processing](https://docs.rual.nl/tutorials/file-upload-processing)

- [Common Blueprint Patterns](https://docs.rual.nl/blueprints/common-patterns)

- [Block Templates, Combinations That Work](https://docs.rual.nl/block-types/block-templates)

- [Build Your First CRUD App](https://docs.rual.nl/getting-started/first-crud-app)

- [Block Quick Reference](https://docs.rual.nl/reference/block-quick-reference)

### Version history

Introduced in [`v10.4.28`](https://docs.rual.nl/core-versions/100428).